home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / gen_bbs / rnrfl110.zip / RNRFL.DOC < prev    next >
Text File  |  1996-01-19  |  19KB  |  395 lines

  1.                     TriBBS FILE LIST UTILITY Version 10.0x
  2.                     TriBBS FILE LIST UTILITY Version  5.0x
  3.                           By: Bertrand Le Guen
  4.                             1995 RnR Software
  5.  
  6.                     TriBBS is a copyright of TriSoft
  7.  
  8.                                 WARNING
  9.                                ==========
  10.  RNRFL.EXE   V10.xx will only run with TRIBBS 10.0 +
  11.  RNRFL5.EXE  V05.xx will only run with TRIBBS  5.xx 
  12.  any other uses of RnRFL normally won't cause you any damage  except
  13. by wasting your time and may be locking your PC ...
  14.  
  15.                                Disclaimer
  16.                                ==========
  17.  Bertrand Le Guen shall not be held responsible for anything this program 
  18. does or doesn't do to you or your property.
  19.  The only thing i can guaranty you is that it will take space on your hard
  20. drive and won't wake up while you are sleeping to eat everything in your
  21. fridge !
  22.  
  23.                            What is Shareware ?
  24.                            ===================
  25.  The shareware concept is great for both programmer and the end-user. 
  26.  
  27.  The programmers can distribute their products without getting involved 
  28. in expensive marketing or advertising. The end-user benefits by receiving 
  29. a full-featured program, usually better than the commercial competition,
  30. and support available directly from the author. But it only works if the 
  31. end-user participates in the shareware concept.
  32.  
  33.  Shareware is not free. After using RnRFL for the suggested 30 day trial 
  34. period, you must pay for continued use of the program.
  35.  
  36.  I have worked hard to produce a good program and the price is very fair.
  37.  
  38.                                What is it
  39.                               ============
  40. The TriBBS File List Utility makes for you :
  41.  
  42.    * all of your Master files list with a summary listing at the beginning
  43.      of the list.
  44. or * your Last Uploaded files list since a certain number of days
  45. or * an enhanced style Directory Listing of all your files areas
  46.       with amounts of Files, and How Many Bytes are in each directory, 
  47.       it also puts the total on the bottom of the screen.
  48.       It Uses PCB Colour Codes that are user defined !
  49.       Completely configurable (colour and separators)
  50. or * search threw your files.lst and update them according to
  51.       the file is in the FILES.LST but not on HD       (del it from list)
  52.       the file is on your HD but not in the FILES.LST  (add or delete it)
  53.       the file size have changed
  54.       the file date have changed
  55. or * ALL of the above at one time
  56. or * Make your DIRS??.BBS on-line for the current user.
  57.       (needs to have a fast PC or at least fast HD ;-) if you don't want
  58.       your user to drop carrier while computing)
  59.       Usefull for sysop who have private files areas and want their user
  60.       to have a colorfull display screen displaying it.
  61.  
  62. Read the HISTORY.DOC file or look at the RNRFL.CFG file to see what has
  63. been added/changed whith this version. (thanks ;-) )
  64.  
  65.                              How To Run It
  66.                              =============
  67.  
  68. RNRFL Option Config_file     
  69.  
  70. Option can be one of the followings :
  71.    MKLIST  will only process the MKLIST  section of the config file
  72.    LASTUP  will only process the LASTUP  section of the config file
  73.    SCREEN  will only process the SCREEN  section of the config file
  74.    FILELST will only process the FILELST section of the config file
  75.    ALL     will process all the sections founded in the config file
  76.            except the LOGON one
  77.    LOGON   will only process the LOGON   section of the config file
  78.  
  79. example : RNRFL MKLIST C:\TRIBBS\UT\RNRFL\RNRFL.CFG
  80. (if you've named your config file RNRFL.CFG, you can omit to specify it !
  81. in this case, just type : RNRFL option)
  82.  
  83. If you forgot everything, just type RNRFL to have some helps :-)
  84.  
  85.                            How To Configure It
  86.                            ===================
  87.  
  88. ==================-------------------------------------------------------
  89. The Configuration File
  90. ==================-------------------------------------------------------
  91. the config file is separated in multiple section which are :
  92. [INIT]    which contain information needed by the program
  93. [MKLIST]  which contain information for making the master files list
  94. [LASTUP]  which contain information for the last uploaded files list
  95. [SCREEN]  which contain information for making the DIRS??.BBS
  96. [FILELST] which contain information for updating FILES.LST
  97. [LOGON]   which contain information for making on-line user sec DIRS??.BBS
  98. [END]     mark the end of the config file
  99.  
  100. for an example of config file look at the file RNRFL.CFG.
  101. You'll see the one that is working on my BBS.
  102.  
  103. ==================-------------------------------------------------------
  104. The INIT section
  105. ==================-------------------------------------------------------
  106. [INIT]    Specifies the beginning of the init section
  107. bbs     = Specifies BBS Name or Heading
  108. sysop   = Specifies Sysop Name
  109. regcode = the famous registration code !B-]
  110. path    = Path to Node 1 WITH Trailing backslash
  111. path2nod= Path to current Node (used by the LOGON section to locate
  112.           the TRIBBS.SYS file created for the on-line user)
  113. display = Path to Display Directory WITH Trailing BackSlash
  114.           this statement is only used by the screen section, so you can
  115.           specify an other directory than your main TriBBS directory if
  116.           you want to test it !!
  117. nocprght= Specifies if you want or not all the copyright notice to be
  118.           include in the list or screen created by RnRFL !
  119.           Choice are : Y or N
  120.  
  121.  
  122. ==================-------------------------------------------------------
  123. THE MKLIST section
  124. ==================-------------------------------------------------------
  125. [MKLIST]  Specifies the beginning of a Master Files List Maker
  126. listfile= Specifies the complete path and file name of the Master list
  127.           to create (MUST BE THE 1ST STATEMENT AFTER THE [MKLIST] SECTION)
  128. addfile = Specifies the complete path and file name of the file to include
  129.           at the beginning of the Master File
  130.           If left blank or removed from the config file, no file will
  131.           be included. I suggest you to left it blank in order to 
  132.           remember that the option exists.
  133. delascii= Specifies if Yes or No RnRFL must delete the ASCII listing
  134.           after having compressed it.
  135.           Choice are : Y or N (default is N)
  136. arccmd  = Specifies the archive type for archiving your Master list
  137.           can be one of the following : ZIP ARJ LHA UC2 RAR
  138.           If you specify something after this statement then you must be
  139.           sure that you have the archiver EXE file in you path !!
  140.           ZIP => PKZIP.EXE
  141.           ARJ => ARJ.EXE
  142.           LHA => LHA.EXE
  143.           RAR => RAR.EXE
  144.           UC2 => UUC.EXE, US.EXE (for ultra stealth comp)
  145. arcdiz  = Specifies the complete path and filename of a file that will
  146.           be renamed in FILE_ID.DIZ and added to the archive.
  147. arccmt  = Specifies the complete path and filename of a file that will
  148.           be added in the archive comment.
  149. arcadd  = Specifies the complete path and filename of a file that will
  150.           be added the archive
  151. private = Specifies if you want to include Private area in the list or not
  152.           Choice are : Y or N
  153. area    = The area statement Specifies the beginning of the creation of
  154.           the list. (MUST BE AT THE END OF THE [MKLIST] SECTION)
  155.           You can specify area with :
  156.            - *      will make the list for ALL you files areas
  157.            - xx     will add to the list the file area xx
  158.            - xx-yy  will add to the list from the area xx to the area yy 
  159.            - xx-*   will add to the list from the area xx to the last area
  160.  
  161. of course you can find more than one area statement in this section
  162. you can find for example :
  163. area = *    | area = 1      | area = 1     | area = 1
  164.             | area = 3-10   | area = 3     | area = 5-10
  165.             | area = 20-*   | area = 5-*   | area = 20-30
  166. and so on ...
  167.  
  168.  
  169.  
  170. By default RnRFL won't delete the ASCII listing made during the process.
  171. if you specify something in the statement 'arccmd=' the same path and
  172. filename (without the extension) will be use for the archive. Then you will
  173. find in the same directory your ASCII and compressed  Master Files Listing.
  174. For example : if listfile = C:\FILES\MASTER.LST and arccmd = ZIP
  175.   you will find in the c:\files directory the files :
  176.           MASTER.LST and MASTER.ZIP
  177.  
  178.                    -----------------------------------
  179.                    IMPORTANT IF YOU USE UC2 compressor
  180.                    -----------------------------------
  181.   if you use the UC2 compressor you must start RnRFL by using the
  182.  command line 'US RnRFL option config_file'. You MUST be sure to have US
  183.  (ultra stealth UC2 exec) in memory before using RnRFL. If not, UC2 won't
  184.  work and cause a "Not Enough memory" error.
  185.  
  186.   Don't forget to execute the EXIT command after this to retrieve US from
  187.  memory if you don't use it !
  188.  
  189.   For example in a batch file you could find :
  190. ===
  191.  US                     (To put Ultra Stealth in memory)
  192.  RNRFL ALL RNRFL.CFG    (RnRFL can use UC2)
  193.  EXIT                   (To remove Ultra Stealth from memory)
  194. ===
  195.  or
  196.  
  197.  US RNRFL ALL RNRFL.CFG (this will have the same result)
  198.  
  199. ==================-------------------------------------------------------
  200. the LASTUP section
  201. ==================-------------------------------------------------------
  202. (Every statement are the same than in the [MKLIST] section except the
  203. 'date =' statement)
  204.  
  205. [LASTUP]  Specifies the beginning of a Last Uploaded files section
  206. listfile= Specifies the complete path and file name of the Master list
  207.           to create
  208. addfile = Specifies the complete path and file name of the file to include
  209.           at the beginning of the Master File
  210.           If left blank or removed from the config file, no file will
  211.           be included. I suggest you to left it blank in order to 
  212.           remember that the option exists.
  213. delascii= Specifies if Yes or No RnRFL must delete the ASCII listing
  214.           after having compressed it.
  215.           Choice are : Y or N
  216. arccmd  = Specifies the archive type for archiving your Master list
  217.           can be one of the following : ZIP ARJ LHA UC2 RAR
  218.           If you specify something after this statement then you must be
  219.           sure that you have the archiver EXE file in you path !!
  220.           ZIP => PKZIP.EXE
  221.           ARJ => ARJ.EXE
  222.           LHA => LHA.EXE
  223.           RAR => RAR.EXE
  224.           UC2 => UUC.EXE, US.EXE (for ultra stealth comp)
  225. arcdiz  = Specifies the complete path and filename of a file that will
  226.           be renamed in FILE_ID.DIZ and added to the archive.
  227. arccmt  = Specifies the complete path and filename of a file that will
  228.           be added in the archive comment.
  229. arcadd  = Specifies the complete path and filename of a file that will
  230.           be added the archive
  231. private = Specifies if you want to include Private area in the list or not
  232.           Choice are : Y or N
  233. date    = Specifies the number of days before to look in the files.lst to
  234.           find last uploaded files !
  235. area    = Specifies the area where new uploaded file might be searched
  236.           the format is the same than in the MKLIST section !
  237.  
  238. ==================-------------------------------------------------------
  239. The SCREEN section
  240. ==================-------------------------------------------------------
  241. [SCREEN]  Mark the beginning of the Display Screen section
  242. clrhead = Specifies the PCB colour code for the title            (def=@X09)
  243. clrarea = Specifies the PCB colour code for Area Number          (def=@X0E)
  244. clrname = Specifies the PCB colour code for Area Name            (def=@X0A)
  245. clrfile = Specifies the PCB colour code for Area Number of files (def=@X0C)
  246. clrbyte = Specifies the PCB colour code for Area Number of Bytes (def=@X0C)
  247. clrprvt = Specifies the PCB colour code for Private Area         (def=@X0C)
  248.           RnRFL will also add a P at the beginning of the line.
  249. separat = Specifies a character that will be used to tabulate the screen !
  250. private = Specifies if you want to include Private area in the list or not
  251.           Choice are : Y or N
  252. seclevel= Specifies which security level display screen is to create.
  253.           It might be ever an integer or ALL for the DIRSALL.BBS screen.
  254.  
  255. Be sure to delete all DIRS*.* in your display directory before using it
  256. the first time to avoid old .ANS screen to be displayed instead of the
  257. new .BBS screen.
  258.  
  259. RnRFL creates only a .BBS with @PCB colour code, so you won't need
  260. anymore .ANS screen !!
  261.  
  262.  
  263. ==================-------------------------------------------------------
  264. The LOGON section
  265. ==================-------------------------------------------------------
  266. [LOGON]  Mark the beginning of the Logon Display Screen section
  267. clrhead = Specifies the PCB colour code for the title            (def=@X09)
  268. clrarea = Specifies the PCB colour code for Area Number          (def=@X0E)
  269. clrname = Specifies the PCB colour code for Area Name            (def=@X0A)
  270. clrfile = Specifies the PCB colour code for Area Number of files (def=@X0C)
  271. clrbyte = Specifies the PCB colour code for Area Number of Bytes (def=@X0C)
  272. clrprvt = Specifies the PCB colour code for Private Area         (def=@X0C)
  273.           RnRFL will also add a P at the beginning of the line.
  274. separat = Specifies a character that will be used to tabulate the screen !
  275. private = Specifies if you want to include Private area in the list or not
  276.           Choice are : Y or N
  277. seclevel= Specifies which security level display screen is to create.
  278.           Choice is : @USER@ ( no choice :-)
  279.           Security level is read in the file TRIBBS.SYS
  280.  
  281. LOGON section have been made because some sysop who have a lot of
  282. private areas couldn't use the screen option to display it!
  283.  
  284. You'll need a fast PC/HD to use it if you have a lot of files areas !
  285.  
  286. You can use the LOGON option in the LOGON.BAT or SEC??.BAT file.
  287. If only your 60 security level user have access to private areas,then
  288. you could only add RNRFL LOGON to the SEC60.BAT.
  289.  
  290. Example : LOGON.BAT or SEC60.BAT
  291.  
  292. cd \tribbs\ut\rnrfl
  293. RnRFL LOGON
  294. cd \tribbs
  295. board
  296.  
  297.  
  298. ==================-------------------------------------------------------
  299. The FILELST section
  300. ==================-------------------------------------------------------
  301. [FILELST]
  302. modlst  = Specifies if you want or not a file that is found in the
  303.           FILES.LST but not on your HD to be deleted from the FILES.LST
  304.           or not
  305.           Choice are : Y or N
  306. add2lst = Specifies if you want a file that is found on your HD but not
  307.           in the FILES.LST to be added to the FILES.LST or to be deleted
  308.           from your HD
  309.           Choice are : Y (add it to FILES.LST) or N (del it from HD)
  310. chksize = Specifies if you want RnRFL to check if the file's size have
  311.           changed
  312.           Choice are : Y or N
  313. chkdate = Specifies if you want RnRFL to check if the file's date have
  314.           changed
  315.           Choice are : Y or N
  316. area    = Specifies the area that are to be checked.
  317.           the format is the same than in the MKLIST section !
  318.  
  319. Check your FILES.LST to check if :
  320.                                         Y        N
  321.  - File found in FILES.LST not on HD  touch    nothing   (modlst )       
  322.  - File found on HD not in FILES.LST  touch    del       (add2lst)
  323.  - File size have changed             touch    nothing   (chksize)
  324.  - File date have changed             touch    nothing   (chkdate)
  325.  
  326. RnRFL will check All your Area Path to find a file !!
  327. No more CD \path1 -> test, CD \Path2 -> test etc. !B-)
  328.  
  329.  
  330.                             Future Versions
  331.                             ===============
  332. Nothing's planned yet ... may be some statistical bulletins and probably
  333. a file announcements for Fidonet style message base ??
  334. if you see something that could improve this one then request me all
  335. the features that you have in mind (see at the end of this documentation
  336. how to contact me)
  337. I'm actually Working on RnRMS and RnRUS, 2 utilities for conferences and
  338. users.
  339.  
  340.                         Registration Information
  341.                         ========================
  342.  Unregistered copies are completely functional. You will only see
  343. the "UNREGISTERED COPY" at the beginning of the file list (Not in the
  344. display screen, cause I HATE soft that makes you fell like a robber).
  345. You will also have to wait 15 seconds at the end of the computing
  346. (except in logon mode cause I hate softs that makes your users pay for
  347. a soft that their sysop didn't register)
  348.  
  349.  This lets you test the program with its true look and feel.
  350.  
  351.  Please encourage me to continue this policy by registering.
  352.  
  353.  RnRFL registration is only $15 ....
  354.  Not too expensive isn't it ??
  355.  
  356.  (Print out REGISTER.FRM for complete ordering information)
  357.  
  358.  After i receive your registration form, you will receive an activation code. 
  359. Because the program is not crippled, the effect your activation code will 
  360. have, will be the elimination of the noisy and annoying shareware message 
  361. and the program will be shown as Registered on the file's listing.
  362.  
  363.  You will also be able to add a statement in the config file that will
  364. suppress all advertisements and copyrights from RnRFL in your screen and
  365. listing.
  366.  
  367.  
  368.                             Support & Contact
  369.                             =================
  370.  
  371. Support may be found on :
  372.  
  373.  - Blue Suede Shoes BBS (33-1) 53 79 01 44 (France)
  374.  - TriBBS Support echo on WME and FIDO. 
  375.  - Fidonet  Netmail 2:320/310 
  376.  - InterNet E-mail at leguen@musical.fdn.org
  377.  
  378.                                  Thanks
  379.                                  =======
  380. All of you that have already registered some RnR software and helps me
  381.  going on devellopements for TriBBS utilities.
  382. Joel Beernaert for
  383.  - being the first one to register RnRFL
  384. Jean-Philippe Luiggi for
  385.  - Showing me TRIBBS and helping me setting it up
  386.  - testing RnRFL and giving me some idea to improve it
  387. Mark Goodwin for
  388.  - TriBBS of course ;-)
  389.  - Continuously improving TriBBS to make it the best and cheaper BBS
  390.    software
  391. Eric Stern for
  392.  - testing and debugging RnRFL
  393. My wife for
  394.  - Stopping shouting at me sometimes when I'm working on my computer :-)
  395.